Interface PolicyClassSetDscp

All Superinterfaces:
IPCObject
All Known Implementing Classes:
PolicyClassSetDscpImpl

public interface PolicyClassSetDscp extends IPCObject
Information provided by the PKI file:

    \class PolicyClassSetDscp
    
    \brief PolicyClassSetDscp handles and manipulates policy-map class DSCP and IP precedence.
    
    \example network().getDevice("Router0").getPolicyMapManager().getPolicyMapAt(0).getClassAt(0).getSetDscpPrec()
    
Author:
Auto-generated
  • Method Details

    • getType

      WredType getType()
      Information provided by the PKI file:
      
          \brief Returns the policy map class type.
          
          \return QoS::EWredType,     the QoS policy type.
          QoS policy types:   eWredDscp = 0,
          eWredPrec = 1
          
              
      Returns:
      WredType Returns a WredType
    • isIpv4Only

      boolean isIpv4Only()
      Information provided by the PKI file:
      
          \brief Returns true if the policy map class is for IPv4 only, otherwise false.
          
          \return bool, true if the policy map class is for IPv4 only, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • getValue

      int getValue()
      Information provided by the PKI file:
      
          \brief Returns the value of the DSCP or IP precedence.
          
          \return int, the value of the DSCP or IP precedence.
          
              
      Returns:
      int Returns a int
    • update

      void update(WredType type, boolean ipv4Only, int value)
      Information provided by the PKI file:
      
          \brief Updates the policy map class with the specified type and value.
          
          \param QoS::EWredType,      the QoS policy type.
          QoS policy types:   eWredDscp = 0,
          eWredPrec = 1
          \param ipv4Only, true for IPv4 only, false for IPv4 and IPv6.
          \param value, the value for the QoS policy type.
          
              
      Parameters:
      type - Takes in a parameter of type
      ipv4Only - Takes in a parameter of ipv4Only
      value - Takes in a parameter of value
    • toString

      String toString(boolean showIpType)
      Information provided by the PKI file:
      
          \brief Returns the output of the policy map class.
          
          \param showIpType, true to display the ip type, false to not display it.
          
          \return string, the output of the policy map class.
          
              
      Parameters:
      showIpType - Takes in a parameter of showIpType
      Returns:
      String Returns a String